home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 5 / MacMania 5.toast / / Internet software / NewsWatcher / NW Source / Shared Code / Libraries & Misc / OpenTptInternet.h < prev    next >
Text File  |  1996-10-01  |  10KB  |  376 lines
  1. /*
  2.     File:        OpenTptInternet.h
  3.  
  4.     Contains:    Client TCP/IP definitions
  5.  
  6.     Copyright:    © 1993-1996 by Apple Computer, Inc., all rights reserved.
  7.  
  8.  
  9. */
  10.  
  11.  
  12. #ifndef __OPENTPTINTERNET__
  13. #define __OPENTPTINTERNET__
  14.  
  15. #ifndef __OPENTRANSPORT__
  16. #include <OpenTransport.h>
  17. #endif    
  18. #if PRAGMA_ALIGN_SUPPORTED
  19. #pragma options align=mac68k
  20. #endif
  21. #if PRAGMA_IMPORT_SUPPORTED
  22. #pragma import on
  23. #endif
  24.  
  25. /*******************************************************************************
  26. ** Misc 
  27. ********************************************************************************/
  28.  
  29. typedef UInt16    InetPort;
  30. typedef UInt32    InetHost;
  31.  
  32. //
  33. //    Enums used as address type designations.
  34. //
  35. enum
  36. {
  37.     AF_INET                = 2,    // Traditonal
  38.     AF_DNS                = 42    // Obviously, the answer to...
  39. };
  40.  
  41. //
  42. //    Enum which can be used to bind to all IP interfaces
  43. //    rather than a specific one.
  44. //
  45. enum
  46. {
  47.     kOTAnyInetAddress    = 0        // Wildcard
  48. };
  49.  
  50. #ifdef __cplusplus
  51.     class    TInternetServices;
  52.     typedef TInternetServices*    InetSvcRef;
  53. #else
  54.     typedef void*    InetSvcRef;
  55. #endif
  56.  
  57. /*******************************************************************************
  58. ** Some prefixes for shared libraries
  59. ********************************************************************************/
  60.  
  61. #define kInetVersion    "3.1.1"
  62. #define kInetPrefix        "ot:inet$"
  63.  
  64. /*******************************************************************************
  65. ** Module Names
  66. ********************************************************************************/
  67. #define kDNRName        "dnr"
  68. #define kTCPName        "tcp"
  69. #define kUDPName        "udp"
  70. #define kRawIPName        "rawip"
  71.  
  72. /*******************************************************************************
  73. ** XTI Options
  74. ********************************************************************************/
  75.  
  76. // Protocol levels
  77.  
  78. #define    INET_IP         0x0
  79. #define    INET_TCP     0x06
  80. #define    INET_UDP     0x11
  81.  
  82.  
  83. // TCP Level Options
  84.  
  85. #define    TCP_NODELAY                     0x01
  86. #define    TCP_MAXSEG                     0x02
  87. #define TCP_NOTIFY_THRESHOLD        0x10    /** not a real XTI option */
  88. #define TCP_ABORT_THRESHOLD            0x11    /** not a real XTI option */
  89. #define TCP_CONN_NOTIFY_THRESHOLD    0x12    /** not a real XTI option */
  90. #define TCP_CONN_ABORT_THRESHOLD    0x13    /** not a real XTI option */
  91. #define TCP_OOBINLINE                0x14    /** not a real XTI option */
  92. #define TCP_URGENT_PTR_TYPE            0x15    /** not a real XTI option */
  93. #define    TCP_KEEPALIVE                 OPT_KEEPALIVE    /* keepalive defined in OpenTransport.h */
  94.  
  95. #define    T_GARBAGE                     2            
  96.  
  97.  
  98. // UDP Level Options
  99.  
  100. #define    UDP_CHECKSUM        OPT_CHECKSUM
  101. #define UDP_RX_ICMP            0x2
  102.  
  103. // IP Level Options
  104.  
  105. #define    IP_OPTIONS             0x01
  106. #define    IP_TOS                 0x02
  107. #define    IP_TTL                 0x03
  108. #define    IP_REUSEADDR         0x04
  109. #define    IP_DONTROUTE         0x10
  110. #define    IP_BROADCAST         0x20
  111. #define    IP_HDRINCL             0x1002    
  112. #define IP_RCVOPTS             0x1005
  113. #define IP_RCVDSTADDR         0x1007
  114. #define    IP_MULTICAST_IF         0x1010        /* set/get IP multicast interface    */
  115. #define    IP_MULTICAST_TTL     0x1011        /* set/get IP multicast timetolive    */
  116. #define    IP_MULTICAST_LOOP     0x1012        /* set/get IP multicast loopback    */
  117. #define    IP_ADD_MEMBERSHIP     0x1013        /* add an IP group membership        */
  118. #define    IP_DROP_MEMBERSHIP     0x1014        /* drop an IP group membership        */
  119. #define    IP_BROADCAST_IF         0x1015        /* Set interface for broadcasts     */
  120. #define    IP_RCVIFADDR         0x1016        /* Set interface for broadcasts     */
  121.  
  122. //    DVMRP-specific setsockopt commands, from ip_mroute.h
  123. //
  124. #define    DVMRP_INIT        100
  125. #define    DVMRP_DONE        101
  126. #define    DVMRP_ADD_VIF    102
  127. #define    DVMRP_DEL_VIF    103
  128. #define    DVMRP_ADD_LGRP    104
  129. #define    DVMRP_DEL_LGRP    105
  130. #define    DVMRP_ADD_MRT    106
  131. #define    DVMRP_DEL_MRT    107
  132.  
  133. // IP_TOS precdence levels
  134. enum
  135. {
  136.     T_ROUTINE        = 0,
  137.     T_PRIORITY        = 1,
  138.     T_IMMEDIATE        = 2,
  139.     T_FLASH            = 3,
  140.     T_OVERRIDEFLASH    = 4,
  141.     T_CRITIC_ECP    = 5,
  142.     T_INETCONTROL    = 6,
  143.     T_NETCONTROL    = 7
  144. };
  145.  
  146. //    IP_TOS type of service
  147. enum
  148. {
  149.     T_NOTOS        = 0x0,        
  150.     T_LDELAY    = (1<<4),
  151.     T_HITHRPT    = (1<<3),
  152.     T_HIREL     = (1<<2)
  153. };
  154.  
  155. #define    SET_TOS(prec,tos)    (((0x7 & (prec)) << 5) | (0x1c & (tos)))
  156.  
  157. // IP Multicast option structures
  158. struct TIPAddMulticast
  159. {
  160.     InetHost multicastGroupAddress;
  161.     InetHost interfaceAddress;
  162. };
  163. typedef struct TIPAddMulticast TIPAddMulticast;
  164.  
  165.  
  166. /*******************************************************************************
  167. ** Protocol-specific events
  168. ********************************************************************************/
  169.  
  170. enum
  171. {
  172.     T_DNRSTRINGTOADDRCOMPLETE    = kPRIVATEEVENT+1,
  173.     T_DNRADDRTONAMECOMPLETE        = kPRIVATEEVENT+2,
  174.     T_DNRSYSINFOCOMPLETE        = kPRIVATEEVENT+3,
  175.     T_DNRMAILEXCHANGECOMPLETE    = kPRIVATEEVENT+4,
  176.     T_DNRQUERYCOMPLETE            = kPRIVATEEVENT+5
  177. };
  178.  
  179. /*******************************************************************************
  180. ** InetAddress
  181. ********************************************************************************/
  182.  
  183. struct InetAddress
  184. {
  185.         OTAddressType    fAddressType;    // always AF_INET
  186.         InetPort        fPort;            // Port number 
  187.         InetHost        fHost;            // Host address in net byte order
  188.         UInt8            fUnused[8];        // Traditional unused bytes
  189. };
  190. typedef struct InetAddress InetAddress;
  191.  
  192. /*******************************************************************************
  193. ** Domain Name Resolver (DNR) 
  194. ********************************************************************************/
  195.  
  196. enum 
  197. { 
  198.         kMaxHostAddrs         =  10,
  199.         kMaxSysStringLen     =  32,
  200.         kMaxHostNameLen        = 255
  201. };
  202.  
  203. typedef char InetDomainName[kMaxHostNameLen + 1];
  204.  
  205. struct InetHostInfo
  206. {
  207.     InetDomainName    name;
  208.     InetHost        addrs[kMaxHostAddrs];
  209. };
  210. typedef struct InetHostInfo    InetHostInfo;
  211.  
  212. struct InetSysInfo
  213. {
  214.     char        cpuType[kMaxSysStringLen];
  215.     char        osType[kMaxSysStringLen];
  216. };
  217. typedef struct InetSysInfo InetSysInfo;
  218.  
  219. struct InetMailExchange
  220. {
  221.     UInt16            preference;
  222.     InetDomainName    exchange;
  223. };
  224. typedef struct InetMailExchange InetMailExchange;
  225.  
  226. struct DNSQueryInfo
  227. {
  228.     UInt16            qType;
  229.     UInt16            qClass;
  230.     UInt32            ttl;
  231.     InetDomainName    name;
  232.     UInt16            responseType;        // answer, authority, or additional
  233.     UInt16            resourceLen;        // actual length of array which follows
  234.     char            resourceData[4];    // size varies
  235. };
  236. typedef struct DNSQueryInfo DNSQueryInfo;
  237.  
  238.  
  239. /*******************************************************************************
  240. ** DNSAddress
  241. **
  242. **        The DNSAddress format is optional and may be used in connects,
  243. **        datagram sends, and resolve address calls.   The name takes the 
  244. **        format "somewhere.com" or "somewhere.com:portnumber" where
  245. **        the ":portnumber" is optional.   The length of this structure
  246. **        is arbitrarily limited to the overall max length of a domain
  247. **        name (255 chars), although a longer one can be use successfully
  248. **        if you use this as a template for doing so.   However, the domain name 
  249. **        is still limited to 255 characters.
  250. ********************************************************************************/
  251.  
  252. struct DNSAddress
  253. {
  254.     OTAddressType    fAddressType;    // always AF_DNS
  255.     InetDomainName    fName;            
  256. };
  257. typedef struct DNSAddress DNSAddress;
  258.  
  259. /*******************************************************************************
  260. ** InetInterfaceInfo
  261. ********************************************************************************/
  262.  
  263. struct InetInterfaceInfo
  264. {
  265.     InetHost        fAddress;
  266.     InetHost        fNetmask;
  267.     InetHost        fBroadcastAddr;
  268.     InetHost        fDefaultGatewayAddr;
  269.     InetHost        fDNSAddr;
  270.     UInt16            fVersion;
  271.     UInt16            fHWAddrLen;
  272.     UInt8*            fHWAddr;
  273.     UInt32            fIfMTU;
  274.     UInt8*            fReservedPtrs[2];
  275.     InetDomainName    fDomainName;
  276.     UInt8            fReserved[256];            
  277. };
  278. typedef struct InetInterfaceInfo InetInterfaceInfo;
  279.  
  280.  
  281.  
  282. /*******************************************************************************
  283. ** Static helper functions
  284. ********************************************************************************/
  285.  
  286. #ifdef __cplusplus
  287. extern "C" {
  288. #endif
  289.  
  290. extern pascal void             OTInitInetAddress(InetAddress* addr, InetPort port, InetHost host);
  291. extern pascal size_t        OTInitDNSAddress(DNSAddress* addr, char* str);
  292. extern pascal OSStatus         OTInetStringToHost(char* str, InetHost* host);
  293. extern pascal void          OTInetHostToString(InetHost host, char* str);
  294. extern pascal OSStatus         OTInetGetInterfaceInfo(InetInterfaceInfo* info, SInt32 val);
  295.  
  296. #ifdef __cplusplus
  297. }
  298. #endif
  299.  
  300.  
  301. /*******************************************************************************
  302. ** InetServices & DNR calls
  303. ********************************************************************************/
  304.  
  305. #define kDefaultInternetServicesPath    ((OTConfiguration*)-3)
  306.  
  307. #if !OTKERNEL
  308.  
  309. #ifdef __cplusplus
  310. extern "C" {
  311. #endif
  312.  
  313. extern pascal InetSvcRef     OTOpenInternetServices(OTConfiguration* cfig, OTOpenFlags oflag, OSStatus* err);
  314. extern pascal OSStatus        OTAsyncOpenInternetServices(OTConfiguration* cfig, OTOpenFlags oflag, 
  315.                                                         OTNotifyProcPtr proc, void* contextPtr);
  316. extern pascal OSStatus         OTInetStringToAddress(InetSvcRef ref, char* name,
  317.                                                   InetHostInfo* hinfo);
  318. extern pascal OSStatus         OTInetAddressToName(InetSvcRef ref, InetHost addr, 
  319.                                                 InetDomainName name);
  320. extern pascal OSStatus         OTInetSysInfo(InetSvcRef ref, char* name,
  321.                                           InetSysInfo* sysinfo);
  322. extern pascal OSStatus         OTInetMailExchange(InetSvcRef ref, char* name, UInt16* num,
  323.                                                InetMailExchange* mx);
  324.                                                
  325. extern pascal OSStatus        OTInetQuery(InetSvcRef ref, char* name, UInt16 qClass, UInt16 qType,
  326.                                           char* buf, size_t buflen, 
  327.                                         void** argv, size_t argvlen,
  328.                                         OTFlags flags);
  329.                     
  330.  
  331. #ifdef __cplusplus
  332. }
  333. #endif
  334.  
  335. enum
  336. {
  337.     kDefaultInetInterface    = -1,
  338.     kInetInterfaceInfoVersion    = 2
  339. };
  340.  
  341. #ifdef __cplusplus
  342.  
  343. class TInternetServices : public TProvider
  344. {
  345.     public:
  346.             OSStatus     StringToAddress(char* name, InetHostInfo* hinfo)
  347.                         { return OTInetStringToAddress(this, name, hinfo); }
  348.                     
  349.             OSStatus     AddressToName(InetHost addr, InetDomainName name)
  350.                         { return OTInetAddressToName(this, addr, name); }
  351.                     
  352.             OSStatus     SysInfo(char* name, InetSysInfo* sysinfo )
  353.                         { return OTInetSysInfo(this, name, sysinfo); }
  354.                     
  355.             OSStatus     MailExchange(char* name, UInt16* num, InetMailExchange* mx)
  356.                         { return OTInetMailExchange(this, name, num, mx); }
  357.                         
  358.             OSStatus    Query(char* name, UInt16 qClass, UInt16 qType, 
  359.                               char* buf, size_t buflen, 
  360.                               void** argv, size_t argvlen,
  361.                               OTFlags flags)
  362.                         { return OTInetQuery(this, name, qClass, qType, buf, buflen, argv, argvlen, flags); }
  363. };
  364.  
  365. #endif
  366. #endif        /* !OTKERNEL */
  367.  
  368. #if PRAGMA_ALIGN_SUPPORTED
  369. #pragma options align=reset
  370. #endif
  371. #if PRAGMA_IMPORT_SUPPORTED
  372. #pragma import off
  373. #endif
  374.  
  375. #endif    /* __OTINTERNET__ */
  376.